<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilloader: xloader_plat_client.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilloader
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xloader__plat__client_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xloader_plat_client.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file Contains the client function prototypes, defines and macros. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00  dd   01/09/24 Initial release
      har  02/16/24 Added XLoader_GetOptionalData API
      har  03/05/24 Fixed doxygen warnings
      kpt  10/04/24 Added support to validate partial and optimized authentication enabled PDI</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:af14fcbd99f3aaf94c6ecc1f3689b8485"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__plat__client_8h.html#af14fcbd99f3aaf94c6ecc1f3689b8485">XLOADER_PDI_SRC_DDR</a>&#160;&#160;&#160;(0xF)</td></tr>
<tr class="memdesc:af14fcbd99f3aaf94c6ecc1f3689b8485"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source of PDI is DDR.  <a href="#af14fcbd99f3aaf94c6ecc1f3689b8485">More...</a><br/></td></tr>
<tr class="separator:af14fcbd99f3aaf94c6ecc1f3689b8485"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bf2f25bb888f10360209991f0fa866a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__plat__client_8h.html#a8bf2f25bb888f10360209991f0fa866a">XLOADER_PDI_SRC_IS</a>&#160;&#160;&#160;(0x10)</td></tr>
<tr class="memdesc:a8bf2f25bb888f10360209991f0fa866a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source of PDI is Image Store.  <a href="#a8bf2f25bb888f10360209991f0fa866a">More...</a><br/></td></tr>
<tr class="separator:a8bf2f25bb888f10360209991f0fa866a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1652b4d0eb7aed02ead9dc01a2308f01"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__plat__client_8h.html#a1652b4d0eb7aed02ead9dc01a2308f01">XLOADER_PDI_TYPE_FULL</a>&#160;&#160;&#160;(0x1U)</td></tr>
<tr class="memdesc:a1652b4d0eb7aed02ead9dc01a2308f01"><td class="mdescLeft">&#160;</td><td class="mdescRight">PDI type full.  <a href="#a1652b4d0eb7aed02ead9dc01a2308f01">More...</a><br/></td></tr>
<tr class="separator:a1652b4d0eb7aed02ead9dc01a2308f01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32a5a2918cb9e891e72c3501ea804e6c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__plat__client_8h.html#a32a5a2918cb9e891e72c3501ea804e6c">XLOADER_PDI_TYPE_PARTIAL</a>&#160;&#160;&#160;(0x2U)</td></tr>
<tr class="memdesc:a32a5a2918cb9e891e72c3501ea804e6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">PDI type partial.  <a href="#a32a5a2918cb9e891e72c3501ea804e6c">More...</a><br/></td></tr>
<tr class="separator:a32a5a2918cb9e891e72c3501ea804e6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae203b8b034ef118a5152903c58269878"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gae203b8b034ef118a5152903c58269878">XLoader_ConfigureJtagState</a> (XLoader_ClientInstance *InstancePtr, u32 Flag)</td></tr>
<tr class="memdesc:gae203b8b034ef118a5152903c58269878"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to configure jtag status.  <a href="group__xloader__client__apis.html#gae203b8b034ef118a5152903c58269878">More...</a><br/></td></tr>
<tr class="separator:gae203b8b034ef118a5152903c58269878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc2cbcde55040cd535bd94e0e3f89ca7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gacc2cbcde55040cd535bd94e0e3f89ca7">XLoader_ReadDdrCryptoPerfCounters</a> (XLoader_ClientInstance *InstancePtr, u32 NodeId, XLoader_DDRCounters *CryptoCounters)</td></tr>
<tr class="memdesc:gacc2cbcde55040cd535bd94e0e3f89ca7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to read DDR crypto performance counters.  <a href="group__xloader__client__apis.html#gacc2cbcde55040cd535bd94e0e3f89ca7">More...</a><br/></td></tr>
<tr class="separator:gacc2cbcde55040cd535bd94e0e3f89ca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaff698654e9776729055a8cdd661afa9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaaff698654e9776729055a8cdd661afa9">XLoader_ValidatePdiAuth</a> (XLoader_ClientInstance *InstancePtr, const u64 PdiAddr, const u32 PdiType)</td></tr>
<tr class="memdesc:gaaff698654e9776729055a8cdd661afa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to validate authenticated PDI based on PDI type.  <a href="group__xloader__client__apis.html#gaaff698654e9776729055a8cdd661afa9">More...</a><br/></td></tr>
<tr class="separator:gaaff698654e9776729055a8cdd661afa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="af14fcbd99f3aaf94c6ecc1f3689b8485"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_PDI_SRC_DDR&#160;&#160;&#160;(0xF)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source of PDI is DDR. </p>

</div>
</div>
<a class="anchor" id="a8bf2f25bb888f10360209991f0fa866a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_PDI_SRC_IS&#160;&#160;&#160;(0x10)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source of PDI is Image Store. </p>

</div>
</div>
<a class="anchor" id="a1652b4d0eb7aed02ead9dc01a2308f01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_PDI_TYPE_FULL&#160;&#160;&#160;(0x1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PDI type full. </p>

</div>
</div>
<a class="anchor" id="a32a5a2918cb9e891e72c3501ea804e6c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_PDI_TYPE_PARTIAL&#160;&#160;&#160;(0x2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PDI type partial. </p>

<p>Referenced by <a class="el" href="group__xloader__server__apis.html#ga165b8b9d58043ef922abac0188d45373">XLoader_MeasureNLoad()</a>, <a class="el" href="group__xloader__server__apis.html#gaadc121bcc59feb4ece3c40802d81987b">XLoader_PdiInit()</a>, <a class="el" href="group__xloader__server__apis.html#gaa912487046c04b1c90ca418a19ac3e0d">XLoader_ProcessAuthEncPrtn()</a>, <a class="el" href="group__xloader__server__apis.html#ga3dbbecc3b2545a3e076d421f086715e6">XLoader_RestartImage()</a>, <a class="el" href="group__xloader__server__apis.html#ga9df696fd17dec50576f817a1cd1f7105">XLoader_SecureEncInit()</a>, and <a class="el" href="group__xloader__client__apis.html#gaaff698654e9776729055a8cdd661afa9">XLoader_ValidatePdiAuth()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
